Skip to main content

DocumentManagementAPI

The DocumentManagementAPI class provides a comprehensive set of methods for managing documents within the system. This includes functionalities for creating, retrieving, updating, and deleting documents, as well as managing their associated metadata and permissions. The API also supports operations for handling document versions, shortcuts, and folder structures, enabling users to efficiently organize and manipulate their document assets.

Methods

NameDescription
CancelBranch(requestVersion, cancellationToken, telemetryCollectorHolder)Cancels a specified branch in the document management system.
DeleteFiles(deleteFilesRequest, cancellationToken, telemetryCollectorHolder)Deletes multiple files based on the provided request.
GetDMObjectsFromPaths(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves document management objects from multiple specified paths.
RenameObject(requestObject, cancellationToken, telemetryCollectorHolder)Renames an object based on the provided request.
DownloadAsync(downloadUrl, cancellationToken, telemetryCollectorHolder)Downloads data from a specified URL in the document management system.
GetRecentObjectsAsync(cancellationToken, telemetryCollectorHolder)Retrieves the most recent objects from the document management system.
AddObjectsToFavoritesAsync(secretKeys, cancellationToken, telemetryCollectorHolder)Adds the specified objects to the user's favorites.
DeleteFolder(deleteFolderRequest, cancellationToken, telemetryCollectorHolder)Deletes a specified folder from the document management system.
GetFolderItemsAsync(loadOptions, fetchedObjectType, secretKey, cancellationToken, telemetryCollectorHolder)Retrieves items within a specified folder.
UpdateTags(requestObject, cancellationToken, telemetryCollectorHolder)Updates tags for specified objects based on the provided request.
GetGridContextAsync(secretKey, cancellationToken, telemetryCollectorHolder)Retrieves the grid context for a specified secret key in the document management system.
Upload(data, uploadParts, cancellationToken, telemetryCollectorHolder)Uploads a byte array as a file using the specified upload parts.
BindObject(bindPermissionGroupWithObjectRequest, cancellationToken, telemetryCollectorHolder)Binds a permission group to a specified object in the document management system.
GetTagsOfObjects(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves tags associated with specified objects.
CopyObjects(requestObject, cancellationToken, telemetryCollectorHolder)Copies objects based on the provided request.
GetRelationFilesOfTheFileAsync(objectKeys, objectSecret, cancellationToken, telemetryCollectorHolder)Retrieves related files for the specified object.
GetDownloadUrl(secretKey, fileName, cancellationToken, telemetryCollectorHolder)Retrieves the download URL for a specified file in the document management system.
DeleteObjectFromFavoritesAsync(secretKey, dmObjectSecret, cancellationToken, telemetryCollectorHolder)Removes a specified object from the favorites in the document management system.
UnsetAsDefaultContent(requestObject, cancellationToken, telemetryCollectorHolder)Unsets a specified content from being the default in the document management system.
CreateRepository(requestObject, cancellationToken, telemetryCollectorHolder)Creates a new repository based on the provided request.
GetSuggestions(getPermissionGroupSuggestionsRequest, cancellationToken, telemetryCollectorHolder)Retrieves suggestions for permission groups based on specified criteria.
MoveObjects(requestObject, cancellationToken, telemetryCollectorHolder)Moves objects based on the provided request.
FilesUpload(parts, cancellationToken, telemetryCollectorHolder)Uploads multiple files using the specified parts.
CreateContent(requestObject, cancellationToken, telemetryCollectorHolder)Creates content in the document management system.
Upload(data, mimeType, uploadParts, cancellationToken, telemetryCollectorHolder)Uploads a byte array as a file using the specified upload parts.
CreateShortcut(requestObject, cancellationToken, telemetryCollectorHolder)Creates a shortcut for specified objects in the document management system.
GetFile(secretKey, cancellationToken, telemetryCollectorHolder)Asynchronously retrieves a file based on the provided secret key.
DeleteFile(requestObject, cancellationToken, telemetryCollectorHolder)Asynchronously deletes a file based on the provided request.
GetFavoritesAsync(managementType, cancellationToken, telemetryCollectorHolder)Retrieves favorite objects from the document management system.
CompleteBranch(requestVersion, cancellationToken, telemetryCollectorHolder)Completes a specified branch in the document management system.
CreateFile(createFileRequest, cancellationToken, telemetryCollectorHolder)Asynchronously creates a new file based on the provided request.
UnbindObject(unbindPermissionGroupWithObjectRequest, cancellationToken, telemetryCollectorHolder)Unbinds a permission group from a specified object in the document management system.
GetCommitList(requestVersion, cancellationToken, telemetryCollectorHolder)Retrieves the list of commits for a specified document in the document management system.
GetFolder(secretKey, cancellationToken, telemetryCollectorHolder)Retrieves a folder based on the provided secret key.
GetDocumentSignatures(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves the signatures for a specified document.
GetObjectsContextAsync(secretKeys, excludeParentTrees, excludePermissions, excludeProperties, cancellationToken, telemetryCollectorHolder)Retrieves the context of objects with additional filtering options.
DeleteRelationFromFileAsync(objectKeys, objectSecret, relatedObjectKey, relatedObjectSecret, cancellationToken, telemetryCollectorHolder)Deletes a relation between two files.
UpdateObjectPermissions(updateObjectPermissionsRequest, cancellationToken, telemetryCollectorHolder)Updates the permissions associated with a specified object in the document management system.
GetContents(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves multiple contents from the document management system.
GetProperties(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves properties of an object based on the provided request.
GetRepositoriesAsync(loadOptions, cancellationToken, telemetryCollectorHolder)Retrieves repositories from the document management system.
SetAsDefaultContent(requestObject, cancellationToken, telemetryCollectorHolder)Sets a specified content as the default in the document management system.
GetPathsAsync(secretKeys, cancellationToken, telemetryCollectorHolder)Asynchronously retrieves the paths of the specified document management objects.
CreateCommit(requestVersion, cancellationToken, telemetryCollectorHolder)Creates a commit for a specified document in the document management system.
GetVersionList(requestVersion, cancellationToken, telemetryCollectorHolder)Retrieves the list of versions for a specified document in the document management system.
GetObjectPermissions(getObjectPermissionsRequest, cancellationToken, telemetryCollectorHolder)Retrieves the permissions associated with a specified object in the document management system.
CreateFiles(createFileRequest, cancellationToken, telemetryCollectorHolder)Creates multiple files based on the provided request.
CreateFolderAsync(folderName, folderDescription, parentFolderSecretKey, cancellationToken, telemetryCollectorHolder)Creates a new folder with the specified name and description.
DownloadsAsync(downloadFilesRequest, cancellationToken, telemetryCollectorHolder)Downloads multiple files from specified URLs in the document management system.
GetAllOfObject(getPermissionGroupsOfObjectRequest, cancellationToken, telemetryCollectorHolder)Retrieves all permission groups associated with a specified object in the document management system.
GetUploadParts(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves upload parts for a document in the document management system.
GetDownloadUrls(getFilesDownloadUrlsRequest, cancellationToken, telemetryCollectorHolder)Retrieves download URLs for multiple files in the document management system.
GetFilesUploadParts(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves upload parts for multiple files in the document management system.
DeleteRepository(requestObject, cancellationToken, telemetryCollectorHolder)Deletes a repository based on the provided request.
GetTags(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves all tags available in the system.
SearchAsync(searchText, objectTypes, searchIn, locationSecretKey, createdBy, modifiedAfter, includeSubChildren, includeRecycleBin, includeFavorites, pagination, cancellationToken, telemetryCollectorHolder)Asynchronously searches for documents based on the provided search criteria.
GetDMObjectsFromPath(requestObject, cancellationToken, telemetryCollectorHolder)Retrieves document management objects from a specified path.
GetObjectsContextAsync(secretKeys, cancellationToken, telemetryCollectorHolder)Retrieves the context of objects based on the provided secret keys.
GetRepository(secretKey, cancellationToken, telemetryCollectorHolder)Retrieves a repository based on the provided secret key.
SearchMembers(searchMembersRequest, cancellationToken, telemetryCollectorHolder)Searches for members in the document management system based on specified criteria.
GetContent(secretKey, cancellationToken, telemetryCollectorHolder)Retrieves content from the document management system using a secret key.
DeleteShortcut(requestObject, cancellationToken, telemetryCollectorHolder)Deletes a specified shortcut from the document management system.
CreateBranch(requestVersion, cancellationToken, telemetryCollectorHolder)Creates a branch for a specified document in the document management system.
GetVersionSuggestion(requestVersion, cancellationToken, telemetryCollectorHolder)Retrieves version suggestions for a specified document in the document management system.
DeleteContent(requestObject, cancellationToken, telemetryCollectorHolder)Deletes content from the document management system.
AddRelationToFileAsync(objectKeys, objectSecret, relatedObjectKeys, relatedObjectSecret, subRelationCheck, cancellationToken, telemetryCollectorHolder)Adds a relation between two files.